Skip to content

docs(www): enhance code blocks #4916

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs(www): enhance code blocks #4916

wants to merge 1 commit into from

Conversation

timdeschryver
Copy link
Member

PR Checklist

Please check if your PR fulfills the following requirements:

PR Type

What kind of change does this PR introduce?

[ ] Bugfix
[ ] Feature
[ ] Code style update (formatting, local variables)
[ ] Refactoring (no functional changes, no api changes)
[ ] Build related changes
[ ] CI related changes
[ ] Documentation content changes
[x] Other... Please describe:

What is the current behavior?

Closes #

What is the new behavior?

  • providing a path to a code block now extracts the code from the given file
  • code blocks are all follow the same theme (our ngrx theme)
  • copied all examples over

Does this PR introduce a breaking change?

[ ] Yes
[x] No

Other information

@netlify Netlify
Copy link

netlify bot commented Aug 9, 2025 •
edited
Loading

✅ Deploy Preview for ngrx-io canceled.

Name Link
🔨 Latest commit 40e4479
🔍 Latest deploy log https://app.netlify.com/projects/ngrx-io/deploys/68984c859b46530008d1d266

@netlify Netlify
Copy link

netlify bot commented Aug 9, 2025 •
edited
Loading

✅ Deploy Preview for ngrx-site-v19 ready!

Name Link
🔨 Latest commit 40e4479
🔍 Latest deploy log https://app.netlify.com/projects/ngrx-site-v19/deploys/68984c850f0daa0008829d0a
😎 Deploy Preview https://deploy-preview-4916--ngrx-site-v19.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@timdeschryver timdeschryver force-pushed the code-blocks branch 3 times, most recently from 2d56995 to 2a24034 Compare August 9, 2025 20:18
timdeschryver
timdeschryver commented Aug 10, 2025
View reviewed changes
Copy link
Member Author

@timdeschryver timdeschryver left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code blocks can't find the correct file to extract the code from.
This results in empty code blocks.

@jdegand
Copy link
Contributor

jdegand commented Aug 12, 2025 •
edited
Loading

@timdeschryver Vite does not expose src/ files by default. fetch() only works for files in the public directory or those explicitly exposed via Vite plugins or server config.

The files can be moved to public/examples. Using import.meta.glob in example-service to replace fetch could be an alternative solution, but this would be more involved (Update: I tried a solution with import.meta.glob, but it appears this doesn't work with SSR).

Using a plugin may only work with development only. I think it would need to be an external API for production.

jdegand
jdegand reviewed Aug 12, 2025
View reviewed changes
projects/www/src/app/components/docs/code-example.component.ts
@@ -35,4 +43,22 @@ import { Component, Input } from '@angular/core';
})
export class CodeExampleComponent {
@Input() header: string = '';
@Input() path: string = '';
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You add a lot of types that can be inferred instead. This will generate ESLint errors and causes a lint error in the build.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@jdegand jdegand jdegand left review comments

At least 2 approving reviews are required to merge this pull request.

Assignees
No one assigned
Labels
Blocked
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@timdeschryver @jdegand